<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  <html xmlns="http://www.w3.org/1999/xhtml">
		<head>
			<!-- template designed by Marco Von Ballmoos -->
			<title>Docs For Class Session</title>
			<link rel="stylesheet" href="../media/stylesheet.css" />
			<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
		</head>
		<body>
			<div class="page-body">			
<h2 class="class-name">Class Session</h2>

<a name="sec-description"></a>
<div class="info-box">
	<div class="info-box-title">Description</div>
	<div class="nav-bar">
					<span class="disabled">Description</span> |
															<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
						
					</div>
	<div class="info-box-body">
        		<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Session class</p>
<p class="description"><p>Wrapper around <div class="src-code"><ol><li><div class="src-line"><span class="src-var">$_SESSION</span></div></li>
</ol></div></p></p>
	<ul class="tags">
				<li><span class="field">author:</span> Jeroen Simons &lt;<a href="mailto:jeroen@melange.nl">jeroen@melange.nl</a>&gt;</li>
				<li><span class="field">copyright:</span> Copyright (c) 2007 Jeroen Simons. All rights reserved</li>
				<li><span class="field">link:</span> <a href="http://www.melange.nl/">http://www.melange.nl/</a></li>
			</ul>
		<p class="notes">
			Located in <a class="field" href="_http---Session.php.html">/http/Session.php</a> (line <span class="field">41</span>)
		</p>
		
				
		<pre></pre>
	
			</div>
</div>




	<a name="sec-method-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Method Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
												<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
		</div>
		<div class="info-box-body">			
			<div class="method-summary">
																																																																																																																												
												<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#getAttribute" title="details" class="method-name">getAttribute</a>
											(<span class="var-type">name</span>&nbsp;<span class="var-name">$name</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">array</span>
										<a href="#getAttributeNames" title="details" class="method-name">getAttributeNames</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#getAuthType" title="details" class="method-name">getAuthType</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#getId" title="details" class="method-name">getId</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#getNote" title="details" class="method-name">getNote</a>
											(<span class="var-type">name</span>&nbsp;<span class="var-name">$name</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#getNoteNames" title="details" class="method-name">getNoteNames</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#getPrincipal" title="details" class="method-name">getPrincipal</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#removeAttribute" title="details" class="method-name">removeAttribute</a>
											(<span class="var-type">name</span>&nbsp;<span class="var-name">$name</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#removeNote" title="details" class="method-name">removeNote</a>
											(<span class="var-type">name</span>&nbsp;<span class="var-name">$name</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#setAttribute" title="details" class="method-name">setAttribute</a>
											(<span class="var-type">name</span>&nbsp;<span class="var-name">$name</span>, <span class="var-type">value</span>&nbsp;<span class="var-name">$value</span>, [<span class="var-type">autoload</span>&nbsp;<span class="var-name">$autoload</span> = <span class="var-default">null</span>])
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#setAuthType" title="details" class="method-name">setAuthType</a>
											(<span class="var-type">authType</span>&nbsp;<span class="var-name">$authType</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#setNew" title="details" class="method-name">setNew</a>
											(<span class="var-type">isNew</span>&nbsp;<span class="var-name">$isNew</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#setNote" title="details" class="method-name">setNote</a>
											(<span class="var-type">name</span>&nbsp;<span class="var-name">$name</span>, <span class="var-type">value</span>&nbsp;<span class="var-name">$value</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$autoload</span> = <span class="var-default">null</span>])
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#setPrincipal" title="details" class="method-name">setPrincipal</a>
											(<span class="var-type">principal</span>&nbsp;<span class="var-name">$principal</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">string</span>
										<a href="#__toString" title="details" class="method-name">__toString</a>
										()
									</div>
								</div>
		</div>
	</div>		

	
	<a name="sec-methods"></a>
	<div class="info-box">
		<div class="info-box-title">Methods</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
																<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
						
		</div>
		<div class="info-box-body">
			<A NAME='method_detail'></A>

<a name="methodgetAttribute" id="getAttribute"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">getAttribute</span> (line <span class="line-number">56</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Return the object bound with the specified name in this session, or  <div class="src-code"><ol><li><div class="src-line"><span class="src-id">null</span></div></li>
</ol></div> if no object is bound with that name.</p>
	<ul class="tags">
				<li><span class="field">exception:</span> IllegalStateException if this method is called on an   invalidated session</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			getAttribute
		</span>
					(<span class="var-type">name</span>&nbsp;<span class="var-name">$name</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">name</span>
				<span class="var-name">$name</span><span class="var-description">: Name of the attribute to be returned</span>			</li>
				</ul>
		
			
	</div>
<a name="methodgetAttributeNames" id="getAttributeNames"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">getAttributeNames</span> (line <span class="line-number">96</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns an <div class="src-code"><ol><li><div class="src-line"><span class="src-id">Enumeration</span></div></li>
</ol></div> of <div class="src-code"><ol><li><div class="src-line"><span class="src-id">String</span></div></li>
</ol></div> objects  containing the names of all the objects bound to this session.</p>
	<ul class="tags">
				<li><span class="field">return:</span> an <div class="src-code"><ol><li><div class="src-line"><span class="src-id">Enumeration</span></div></li>
</ol></div> of          <div class="src-code"><ol><li><div class="src-line"><span class="src-id">String</span></div></li>
</ol></div> objects specifying the          names of all the objects bound to          this session</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">array</span>
		<span class="method-name">
			getAttributeNames
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodgetAuthType" id="getAuthType"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">getAuthType</span> (line <span class="line-number">134</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Return the authentication type used to authenticate our cached  Principal, if any.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			getAuthType
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodgetId" id="getId"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">getId</span> (line <span class="line-number">154</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Return the session identifier for this session.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			getId
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodgetNote" id="getNote"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">getNote</span> (line <span class="line-number">191</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Return the object bound with the specified name to the internal notes  for this session, or <div class="src-code"><ol><li><div class="src-line"><span class="src-id">null</span></div></li>
</ol></div> if no such binding exists.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			getNote
		</span>
					(<span class="var-type">name</span>&nbsp;<span class="var-name">$name</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">name</span>
				<span class="var-name">$name</span><span class="var-description">: Name of the note to be returned</span>			</li>
				</ul>
		
			
	</div>
<a name="methodgetNoteNames" id="getNoteNames"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">getNoteNames</span> (line <span class="line-number">200</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Return an Iterator containing the String names of all notes bindings  that exist for this session.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			getNoteNames
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodgetPrincipal" id="getPrincipal"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">getPrincipal</span> (line <span class="line-number">166</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Return the authenticated Principal that is associated with this Session.</p>
<p class="description"><p>This provides an <div class="src-code"><ol><li><div class="src-line"><span class="src-id">Authenticator</span></div></li>
</ol></div> with a means to cache a  previously authenticated Principal, and avoid potentially expensive  <div class="src-code"><ol><li><div class="src-line"><span class="src-id">Realm</span>.<span class="src-id">authenticate</span><span class="src-sym">(</span><span class="src-sym">)</span></div></li>
</ol></div> calls on every request.  If there  is no current associated Principal, return <div class="src-code"><ol><li><div class="src-line"><span class="src-id">null</span></div></li>
</ol></div>.</p></p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			getPrincipal
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodremoveAttribute" id="removeAttribute"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">removeAttribute</span> (line <span class="line-number">125</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Removes the object bound with the specified name from this session. If the session does not have an object bound with the specified name, this method does nothing.</p>
<p class="description"><p>After this method executes, and if the object  implements <div class="src-code"><ol><li><div class="src-line"><span class="src-id">HttpSessionBindingListener</span></div></li>
</ol></div>,  the container calls  <div class="src-code"><ol><li><div class="src-line"><span class="src-id">HttpSessionBindingListener</span>.<span class="src-id">valueUnbound</span></div></li>
</ol></div>. The container  then notifies any <div class="src-code"><ol><li><div class="src-line"><span class="src-id">HttpSessionAttributeListener</span></div></li>
</ol></div>s in the web  application.</p></p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			removeAttribute
		</span>
					(<span class="var-type">name</span>&nbsp;<span class="var-name">$name</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">name</span>
				<span class="var-name">$name</span><span class="var-description">: the name of the object to              remove from this session</span>			</li>
				</ul>
		
			
	</div>
<a name="methodremoveNote" id="removeNote"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">removeNote</span> (line <span class="line-number">228</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Remove any object bound to the specified name in the internal notes  for this session.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			removeNote
		</span>
					(<span class="var-type">name</span>&nbsp;<span class="var-name">$name</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">name</span>
				<span class="var-name">$name</span><span class="var-description">: Name of the note to be removed</span>			</li>
				</ul>
		
			
	</div>
<a name="methodsetAttribute" id="setAttribute"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">setAttribute</span> (line <span class="line-number">80</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Bind an object to this session, using the specified name.  If an object of the same name is already bound to this session, the object is replaced.</p>
<p class="description"><p>After this method executes, and if the object implements  <div class="src-code"><ol><li><div class="src-line"><span class="src-id">HttpSessionBindingListener</span></div></li>
</ol></div>, the container calls  <div class="src-code"><ol><li><div class="src-line"><span class="src-id">valueBound</span><span class="src-sym">(</span><span class="src-sym">)</span></div></li>
</ol></div> on the object.</p></p>
	<ul class="tags">
				<li><span class="field">exception:</span> IllegalStateException if this method is called on an   invalidated session</li>
				<li><span class="field">exception:</span> IllegalArgumentException if an attempt is made to add a   non-serializable object in an environment marked distributable.</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			setAttribute
		</span>
					(<span class="var-type">name</span>&nbsp;<span class="var-name">$name</span>, <span class="var-type">value</span>&nbsp;<span class="var-name">$value</span>, [<span class="var-type">autoload</span>&nbsp;<span class="var-name">$autoload</span> = <span class="var-default">null</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">name</span>
				<span class="var-name">$name</span><span class="var-description">: Name to which the object is bound, cannot be null</span>			</li>
					<li>
				<span class="var-type">value</span>
				<span class="var-name">$value</span><span class="var-description">: Object to be bound, cannot be null</span>			</li>
					<li>
				<span class="var-type">autoload</span>
				<span class="var-name">$autoload</span><span class="var-description">: Path to an Object so  autoloading will happen properly. $name must be a path to the class</span>			</li>
				</ul>
		
			
	</div>
<a name="methodsetAuthType" id="setAuthType"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">setAuthType</span> (line <span class="line-number">146</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Set the authentication type used to authenticate our cached  Principal, if any.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			setAuthType
		</span>
					(<span class="var-type">authType</span>&nbsp;<span class="var-name">$authType</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">authType</span>
				<span class="var-name">$authType</span><span class="var-description">: The new cached authentication type</span>			</li>
				</ul>
		
			
	</div>
<a name="methodsetNew" id="setNew"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">setNew</span> (line <span class="line-number">238</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Set the <div class="src-code"><ol><li><div class="src-line"><span class="src-id">isNew</span></div></li>
</ol></div> flag for this session.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			setNew
		</span>
					(<span class="var-type">isNew</span>&nbsp;<span class="var-name">$isNew</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">isNew</span>
				<span class="var-name">$isNew</span><span class="var-description">: The new value for the <div class="src-code"><ol><li><div class="src-line"><span class="src-id">isNew</span></div></li>
</ol></div> flag</span>			</li>
				</ul>
		
			
	</div>
<a name="methodsetNote" id="setNote"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">setNote</span> (line <span class="line-number">217</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Bind an object to a specified name in the internal notes associated  with this session, replacing any existing binding for this name.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			setNote
		</span>
					(<span class="var-type">name</span>&nbsp;<span class="var-name">$name</span>, <span class="var-type">value</span>&nbsp;<span class="var-name">$value</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$autoload</span> = <span class="var-default">null</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">name</span>
				<span class="var-name">$name</span><span class="var-description">: Name to which the object should be bound</span>			</li>
					<li>
				<span class="var-type">value</span>
				<span class="var-name">$value</span><span class="var-description">: Object to be bound to the specified name</span>			</li>
					<li>
				<span class="var-type"></span>
				<span class="var-name">$autoload</span>			</li>
				</ul>
		
			
	</div>
<a name="methodsetPrincipal" id="setPrincipal"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">setPrincipal</span> (line <span class="line-number">180</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Set the authenticated Principal that is associated with this Session.</p>
<p class="description"><p>This provides an <div class="src-code"><ol><li><div class="src-line"><span class="src-id">Authenticator</span></div></li>
</ol></div> with a means to cache a  previously authenticated Principal, and avoid potentially expensive  <div class="src-code"><ol><li><div class="src-line"><span class="src-id">Realm</span>.<span class="src-id">authenticate</span><span class="src-sym">(</span><span class="src-sym">)</span></div></li>
</ol></div> calls on every request.</p></p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			setPrincipal
		</span>
					(<span class="var-type">principal</span>&nbsp;<span class="var-name">$principal</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">principal</span>
				<span class="var-name">$principal</span><span class="var-description">: The new Principal, or <div class="src-code"><ol><li><div class="src-line"><span class="src-id">null</span></div></li>
</ol></div> if none</span>			</li>
				</ul>
		
			
	</div>
<a name="method__toString" id="__toString"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">__toString</span> (line <span class="line-number">248</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">String representation of this Session</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			__toString
		</span>
				()
			</div>
	
		
			
	</div>
						
		</div>
	</div>


	<p class="notes" id="credit">
		Documentation generated on Sun, 10 Feb 2008 15:16:19 +0200 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.0</a>
	</p>
	</div></body>
</html>